<!DOCTYPE html>
<html lang="en">
  <head>
    <title>RingProgress Enumeration Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset='utf-8'>
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a name="//apple_ref/swift/Enum/RingProgress" class="dashAnchor"></a>
    <a title="RingProgress Enumeration Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="../index.html">UICircularProgressRing 7.0.0 Docs</a> (100% documented)</p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="../index.html">UICircularProgressRing Reference</a>
        <img id="carat" src="../img/carat.png" />
        RingProgress Enumeration Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="../Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Enums/RingAxis.html">RingAxis</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/RingColor.html">RingColor</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/RingProgress.html">RingProgress</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/TimerRingTimeUnit.html">TimerRingTimeUnit</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Structs/IndeterminateRing.html">IndeterminateRing</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PercentFormattedText.html">PercentFormattedText</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/ProgressRing.html">ProgressRing</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/Ring.html">Ring</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RingStyle.html">RingStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/TimerRing.html">TimerRing</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>RingProgress</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">RingProgress</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">RingProgress</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>

                </div>
              </div>
            <h1 id='progress' class='heading'>Progress</h1>

<p>A type representing some progress.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing0cB0O7percentyACSdcACmF"></a>
                    <a name="//apple_ref/swift/Element/percent(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing0cB0O7percentyACSdcACmF">percent(_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A floating point value to describe progress as a percentage.
Percentage is described in floating point representation,
i.e. <code>100% = 1</code>, <code>50%  = 0.5</code>, <code>0% = 0</code></p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">percent</span><span class="p">(</span><span class="kt">Double</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing0cB0O13indeterminateyA2CmF"></a>
                    <a name="//apple_ref/swift/Element/indeterminate" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing0cB0O13indeterminateyA2CmF">indeterminate</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>An indeterminate percentage value.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">case</span> <span class="n">indeterminate</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Percentage%20%2B%20External"></a>
                <a name="//apple_ref/swift/Section/Percentage + External" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Percentage%20%2B%20External"></a>
                  <h3 class="section-name"><p>Percentage + External</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing0cB0O15isIndeterminateSbvp"></a>
                    <a name="//apple_ref/swift/Property/isIndeterminate" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing0cB0O15isIndeterminateSbvp">isIndeterminate</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Whether the progress value is determinate or not, i.e. not a percentage.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">isIndeterminate</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing0cB0O8asDoubleSdSgvp"></a>
                    <a name="//apple_ref/swift/Property/asDouble" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing0cB0O8asDoubleSdSgvp">asDouble</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Attempts to convert to double, if <code><a href="../Enums/RingProgress.html#/s:22UICircularProgressRing0cB0O15isIndeterminateSbvp">isIndeterminate</a></code> is <code>true</code> this returns <code>nil</code>.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">asDouble</span><span class="p">:</span> <span class="kt">Double</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2020 <a class="link" href="http://ucpr.luispadron.com" target="_blank" rel="external">Luis Padron</a>. All rights reserved. (Last updated: 2020-07-12)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
